Architcture Decision Records(ADR)
markdownで、決められたフォーマットで、1事項1ファイル
DeepL.iconLightweight Architecture Decision Recordsは、重要なアーキテクチャ上の決定事項を、その背景や結果とともに記録するための手法である。これらの詳細をwikiやWebサイトではなく、ソースコントロールに保存することをお勧めします。ほとんどのプロジェクトでは、この手法を使わない理由はないでしょう。
markdownで書く
ファイル名は機械的に1から振ればいい
フォーマット
タイトル(Title)
コンテキスト(Context)
決定(Decision)
ステータス(Status)
結果(Consequences)
adr-<3桁の数字>-タイトル.md
ステータス
提案中
受理
廃止
フロー
adr書く
議論する
受理 or 廃止を決めて更新
受理後、しばらくして「結果」欄を更新(どう使われているか、どうなったのかなど)
その他
adrは開発者なら誰でも提起できる
adrの議論は全員参加でなくてもいい
adrの対象目安は「ソフトウェアの複数箇所に波及する」or「プロジェクト固有の意志」
変数名には分かりやすい名前をつける ← こういうのは取り上げない
なぜその設計にしたかという根拠を残しておく for 後の人
フォーマットは自由